PublishHTMLStepTest.java

/*
 * The MIT License
 *
 * Copyright 2015 Jesse Glick.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package htmlpublisher.workflow;

import edu.umd.cs.findbugs.annotations.NonNull;
import htmlpublisher.HtmlPublisherTarget;
import hudson.model.Action;
import hudson.model.FreeStyleProject;
import hudson.model.Node;
import hudson.model.Result;
import hudson.model.queue.QueueTaskFuture;
import hudson.slaves.DumbSlave;
import hudson.slaves.NodeProperty;
import hudson.slaves.RetentionStrategy;
import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Collections;
import org.hamcrest.Matchers;
import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
import org.jenkinsci.plugins.workflow.job.WorkflowJob;
import org.jenkinsci.plugins.workflow.job.WorkflowRun;
import org.jenkinsci.plugins.workflow.steps.Step;
import org.jenkinsci.plugins.workflow.steps.StepConfigTester.StepBuilder;
import org.junit.Test;
import static org.junit.Assert.*;
import org.junit.Before;
import org.junit.Rule;
import org.junit.rules.TemporaryFolder;
import org.jvnet.hudson.test.JenkinsRule;

public class PublishHTMLStepTest {

    @Rule
    public JenkinsRule r = new JenkinsRule();

    @Rule
    public TemporaryFolder tmp = new TemporaryFolder();

    private WorkflowJob job;
    private WorkflowRun run;
    private File testWorkspace;
    private File testReportDir;

    private static final String TEST_REPORT_DIR = "testReportDir";
    private static final String TEST_PROJECT_NAME = "p";

    @Before
    public void setupReportFolder() throws IOException {
        testWorkspace = tmp.newFolder("workflowWS");
        testReportDir = new File(testWorkspace, "workspace/" + TEST_PROJECT_NAME + "/" + TEST_REPORT_DIR);
    }

    @Test
    public void configRoundTrip() throws Exception {
        configRoundTrip("Foo", "archive", "index.html");
        configRoundTrip("Foo2", "archive/foo/bar", "index2.html");
        configRoundTrip("Foo", "archive", "**");
        configRoundTrip("Report", "archive", "index.html", false, false, false);
        configRoundTrip("Report", "archive", "index.html", true, true, true);
        configRoundTrip("Report", "archive", "index.html", true, false, false);
        configRoundTrip("Report", "archive", "index.html", false, true, false);
        configRoundTrip("Report", "archive", "index.html", false, false, true);
    }

    @Test
    public void publishReportOnProjectLevel() throws Exception {

        // Prepare the environment
        writeTestHTML("index.html");

        // Run the project
        final HtmlPublisherTarget target = new HtmlPublisherTarget
            ("testReport", TEST_REPORT_DIR, "index.html", "", false, false, false);
        setupAndRunProject(target);

        // Ensure that the report has been attached properly
        r.assertBuildStatus(Result.SUCCESS, run);
        HtmlPublisherTarget.HTMLAction jobReport = job.getAction(HtmlPublisherTarget.HTMLAction.class);
        HtmlPublisherTarget.HTMLBuildAction buildReport = run.getAction(HtmlPublisherTarget.HTMLBuildAction.class);
        assertNotNull("Report should be present at the project level", jobReport);
        assertEquals(target.getReportName(), jobReport.getHTMLTarget().getReportName());
        assertNull("Report should be missing at the run level", buildReport);
    }

    @Test
    public void publishReportOnBuildLevel() throws Exception {

        // Prepare the environment
        writeTestHTML("index.html");

        // Run the project
        final HtmlPublisherTarget target = new HtmlPublisherTarget
            ("testReport", TEST_REPORT_DIR, "index.html", "index", true, false, false);
        setupAndRunProject(target);

        // Ensure that the report has been attached properly
        r.assertBuildStatus(Result.SUCCESS, run);
        HtmlPublisherTarget.HTMLAction jobReport = job.getAction(HtmlPublisherTarget.HTMLAction.class);
        HtmlPublisherTarget.HTMLBuildAction buildReport = run.getAction(HtmlPublisherTarget.HTMLBuildAction.class);
        assertNotNull("Report should be present at the project level", jobReport);
        assertEquals(target.getReportName(), jobReport.getHTMLTarget().getReportName());
        assertNotNull("Report should be present at the run level", buildReport);
        assertEquals(target.getReportName(), buildReport.getHTMLTarget().getReportName());
    }

    @Test
    public void publishMissingReportFolder() throws Exception {
        final String missingReportDir = "testReportDirNonExistent";
        final HtmlPublisherTarget target = new HtmlPublisherTarget
            ("testReport", missingReportDir, "index.html", "index", false, false, false);
        setupAndRunProject(target);
        File missingReportDirFile = new File(testWorkspace, "workspace/" + TEST_PROJECT_NAME + "/" + missingReportDir);

        // Ensure that the report has been attached
        r.assertBuildStatus(Result.FAILURE, run);
        HtmlPublisherTarget.HTMLBuildAction report = run.getAction(HtmlPublisherTarget.HTMLBuildAction.class);
        assertNull("Report should be missing", report);
        r.assertLogContains("Specified HTML directory '" + missingReportDirFile + "' does not exist.", run);
    }

    @Test
    public void publishMissingReport_allowMissing() throws Exception {
        setupAndRunProject(new HtmlPublisherTarget("testReport", "testReportDirNonExistent", "index.html", "index",
                false, false, true));

        // Ensure that the report has been attached
        r.assertBuildStatus(Result.SUCCESS, run);
        HtmlPublisherTarget.HTMLBuildAction report = run.getAction(HtmlPublisherTarget.HTMLBuildAction.class);
        assertNull("Report should be missing", report);
    }

    private void writeTestHTML(String fileName) throws Exception {
        // Prepare the test file
        if (!testReportDir.exists() && !testReportDir.mkdirs()) {
            fail("Cannot create a temporary directory for the test");
        }
        final File index = new File(testReportDir, fileName);
        BufferedWriter bw = new BufferedWriter(new PrintWriter(index, "UTF-8"));
        try {
            bw.write("<html><head><title>Test page</title></head><body><p>Jenkins Rocks!</p></body></html>");
        } finally {
            bw.close();
        }
    }

    private void setupAndRunProject(@NonNull HtmlPublisherTarget target) throws Exception {

        // Test node for the workflow
        r.jenkins.addNode(new DumbSlave("slave", "dummy", testWorkspace.getPath(), "1",
                Node.Mode.NORMAL, "", r.createComputerLauncher(null), RetentionStrategy.NOOP,
                Collections.<NodeProperty<?>>emptyList())); // TODO JENKINS-26398 clumsy

        job = r.jenkins.createProject(WorkflowJob.class, TEST_PROJECT_NAME);
        job.setDefinition(new CpsFlowDefinition(""
                + "node('slave') {\n"
                + "  publishHTML(target: [allowMissing: " + target.getAllowMissing() +
                  ", keepAll: " + target.getKeepAll() + ", reportDir: '" + target.getReportDir() +
                  "', reportFiles: '" + target.getReportFiles() + "', reportName: '" + target.getReportName() + "']) \n"
                + "}", true));
        QueueTaskFuture<WorkflowRun> runFuture = job.scheduleBuild2(0, new Action[0]);
        assertThat("build was actually scheduled", runFuture, Matchers.notNullValue());
        run = runFuture.get();
    }

    private void configRoundTrip(String reportName, String reportDir, String reportFiles) throws Exception {
        configRoundTrip(new HtmlPublisherTarget(reportName, reportDir, reportFiles, "index",
                false, false, false));
    }

    private void configRoundTrip(String reportName, String reportDir, String reportFiles,
            boolean keepAll, boolean alwaysLinkToLastBuild, boolean allowMissing) throws Exception {
        configRoundTrip(new HtmlPublisherTarget(reportName, reportDir, reportFiles, "index",
                keepAll, alwaysLinkToLastBuild, allowMissing));
    }

    private void configRoundTrip(@NonNull HtmlPublisherTarget target) throws Exception {
        configRoundTrip(new PublishHTMLStep(target));
    }

    private void configRoundTrip(@NonNull PublishHTMLStep step) throws Exception {
        FreeStyleProject p = r.createFreeStyleProject();
        p.getBuildersList().add(new StepBuilder(step));
        // workaround for eclipse compiler Ambiguous method call
        p.save();
        r.jenkins.reload();

        FreeStyleProject reloaded = r.jenkins.getItemByFullName(p.getFullName(), FreeStyleProject.class);
        assertNotNull(reloaded);
        StepBuilder b = reloaded.getBuildersList().get(StepBuilder.class);
        assertNotNull(b);
        Step after = b.s;
        assertNotNull(after);
        assertEquals(step.getClass(), after.getClass());
        assertEquals("Initial and reloaded target configurations differ", step.getTarget(),
                ((PublishHTMLStep)after).getTarget());
    }
}